TryAddToAny Method (BlockingCollection(T)[], T, Int32, CancellationToken)

Task Parallel System.Threading

previous page next page

Attempts to add the specified item to any one of the specified BlockingCollection<(Of <(T>)>) instances. A OperationCanceledException is thrown if the CancellationToken is canceled.

Namespace:  System.Collections.Concurrent
Assembly:  System.Threading (in System.Threading.dll)

Syntax

Visual Basic (Declaration)
Public Shared Function TryAddToAny ( _
	collections As BlockingCollection(Of T)(), _
	item As T, _
	millisecondsTimeout As Integer, _
	cancellationToken As CancellationToken _
) As Integer
C#
public static int TryAddToAny(
	BlockingCollection<T>[] collections,
	T item,
	int millisecondsTimeout,
	CancellationToken cancellationToken
)

Parameters

collections
Type: array< System.Collections.Concurrent..::.BlockingCollection<(Of <(T>)>) >[]()[]
The array of collections.
item
Type: T
The item to be added to one of the collections.
millisecondsTimeout
Type: System..::.Int32
The number of milliseconds to wait, or Infinite (-1) to wait indefinitely.
cancellationToken
Type: System.Threading..::.CancellationToken
A cancellation token to observe.

Return Value

The index of the collection in the collections array to which the item was added, or -1 if the item could not be added.

Exceptions

ExceptionCondition
System..::.OperationCanceledExceptionIf the CancellationToken is canceled.
System..::.ArgumentNullExceptionThe collections argument is null.
System..::.ArgumentExceptionThe collections argument is a 0-length array or contains a null element, or at least one of collections has been marked as complete for adding.
System..::.ObjectDisposedExceptionAt least one of the BlockingCollection<(Of <(T>)>) instances has been disposed.
System..::.ArgumentOutOfRangeExceptionmillisecondsTimeout is a negative number other than -1, which represents an infinite time-out.
System..::.InvalidOperationExceptionAt least one underlying collection didn't accept the item.
System..::.ArgumentOutOfRangeExceptionThe count of collections is greater than the maximum size of 62 for STA and 63 for MTA.

See Also

previous page start next page